home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / uhren & terminkalender / time / proxwatch / proxwatch.guide (.txt) < prev    next >
Amigaguide Document  |  1996-04-07  |  9KB  |  187 lines
  1. @DATABASE "ProxWatch Documentation"
  2. @AUTHOR   "Boris Folgmann"
  3. @(C)      "PROXITY SOFTWORKS"
  4. ## $Id: ProxWatch.guide,v 1.3 1994/09/04 21:04:00 folgmann Exp folgmann $
  5. @$VER: ProxWatch.guide 1.3 (4.9.94)
  6. @NODE MAIN "ProxWatch"
  7.                  @{b}ProxWatch@{ub} - Localized Font-Sensitive Watch
  8.            Freeware 
  9.  1994 by @{"PROXITY SOFTWORKS" LINK "PSI/PROXITY SOFTWORKS"}
  10.               Development by @{"Boris Folgmann" LINK "PSI/Boris Folgmann"}
  11.     ProxWatch 1.2 (4.9.94)    User Manual
  12.     @{" Copyrights          " LINK COPYRIGHTS}    Copyright information.
  13.     @{" Disclaimer          " LINK PSI/DISCLAIMER}    Legal stuff.
  14.     @{" Description         " LINK DESCRIPTION}    What is it for?
  15.     @{" System requirements " LINK REQUIREMENTS}    What is needed?
  16.     @{" Contents            " LINK CONTENTS}    Archive contents.
  17.     @{" Installation        " LINK INSTALLATION}    How to install.
  18.     @{" Usage               " LINK USAGE}    How is it used?
  19.     @{" Tooltypes           " LINK TOOLTYPES}    Available options.
  20.     @{" Menus               " LINK MENUS}    Available menuitems.
  21.     @{" History             " LINK HISTORY}    What's new?
  22.     @{" Support             " LINK PSI/SUPPORT}    How to contact us.
  23.     @{" Update              " LINK PSI/UPDATE}    Where to get new releases.
  24.     @{" Credits             " LINK PSI/CREDITS}    Thanks to some persons.
  25. @ENDNODE
  26. ###########################################################################
  27. @NODE COPYRIGHTS
  28.                                 COPYRIGHTS
  29.                    Unless otherwise noted, all files are
  30.                    Freeware 
  31.  1994 by @{"PROXITY SOFTWORKS" LINK "PSI/PROXITY SOFTWORKS"}
  32.                            All Rights Reserved.
  33.                      MagicWB 
  34.  1994 Martin Huttenloher
  35.              Kickstart and Workbench are Copyright 
  36.  1985-1994
  37.                            Commodore-Amiga, Inc.
  38. @ENDNODE
  39. ###########################################################################
  40. @NODE DESCRIPTION
  41.               
  42.                                 DESCRIPTION
  43.  o ProxWatch is a small utility for your WBStartup drawer.
  44.  o The string used for displaying date and time is totally user definable.
  45.  o The window can be opened on your favourite public screen.
  46.  o Using a borderless backdrop window the watch text may be visually
  47.    attached to the screen title.
  48. @ENDNODE
  49. ###########################################################################
  50. @NODE REQUIREMENTS
  51.                             SYSTEM REQUIREMENTS
  52. @{"Kickstart" LINK COPYRIGHTS} 2.04
  53. @{"Workbench" LINK COPYRIGHTS} 2.1 for locale.library V38
  54. Amigaguide.library V34 for enabling the Help menuitem.
  55. @ENDNODE
  56. ###########################################################################
  57. @NODE CONTENTS
  58.                                  CONTENTS
  59. This software package consists of the following files:
  60. @{fg highlight}ProxWatch@{fg text}
  61.     ProxWatch for all Amigas.
  62. @{fg highlight}ProxWatch020@{fg text}
  63.     ProxWatch for Amigas equipped with a MC68020 CPU or better.
  64.     Slightly shorter and faster.
  65. @{fg highlight}ProxWatch.guide@{fg text}
  66.     This AmigaGuide document for Multiview.
  67. @{FG HIGHLIGHT}PSI@{FG TEXT}
  68.     @{"Proxity Softworks" LINK "PSI/PROXITY SOFTWORKS"} information text.
  69. Some icons are part of @{"MagicWB" LINK COPYRIGHTS} and included with permission of the author.
  70. @ENDNODE
  71. ###########################################################################
  72. @NODE INSTALLATION
  73.                                INSTALLATION
  74. Simply drag the appropriate version of ProxWatch to your WBStartup drawer.
  75. If   you   want   to   install  this  documentation  on  your  system  copy
  76. 'ProxWatch.guide'  and 'PSI' to a directory of your choice and set tooltype
  77. @{"HELPTEXT" LINK TOOLTYPES} to 'your_directory/ProxWatch.guide'.
  78. Suggested  path  is  'HELP:english/'  which  only  exists on systems running
  79. Workbench 3.0.
  80. @ENDNODE
  81. ###########################################################################
  82. @NODE USAGE
  83.                                    USAGE
  84. ProxWatch  uses  a  template for printing the time and date in it's window.
  85. The default string is '%T' which prints the time only, e.g. '01:23:45'.
  86. You may change this by editing the tooltype @{"WATCHSTRING" LINK TOOLTYPES}.
  87. For example try:
  88. @{fg highlight}Date: %d.%m.%y - Time %T@{fg text}
  89. this may result in 'Date: 17.8.94 - Time: 16:59:12'
  90. For more detailed information see @{"date format" LINK DATEFORMAT}.
  91. @ENDNODE
  92. ###########################################################################
  93. @NODE DATEFORMAT
  94.                                 DATE FORMAT
  95. The   template  describing  the  desired  format  for  the  date.  This  is
  96. constructed just like C-language printf() statements, except that different
  97. formatting  codes are used. Just like in C, formatting codes start with a %
  98. followed by the formatting command. The following commands are accepted by
  99.     %a - abbreviated weekday name
  100.     %A - weekday name
  101.     %b - abbreviated month name
  102.     %B - month name
  103.     %c - same as "%a %b %d %H:%M:%S %Y"
  104.     %C - same as "%a %b %e %T %Z %Y"
  105.     %d - day number with leading 0s
  106.     %D - same as "%m/%d/%y"
  107.     %e - day number with leading spaces
  108.     %h - abbreviated month name
  109.     %H - hour using 24-hour style with leading 0s
  110.     %I - hour using 12-hour style with leading 0s
  111.     %j - julian date
  112.     %m - month number with leading 0s
  113.     %M - the number of minutes with leading 0s
  114.     %n - insert a linefeed
  115.     %p - AM or PM strings
  116.     %q - hour using 24-hour style
  117.     %Q - hour using 12-hour style
  118.     %r - same as "%I:%M:%S %p"
  119.     %R - same as "%H:%M"
  120.     %S - number of seconds with leadings 0s
  121.     %t - insert a tab character
  122.     %T - same as "%H:%M:%S"
  123.     %U - week number, taking Sunday as first day of week
  124.     %w - weekday number
  125.     %W - week number, taking Monday as first day of week
  126.     %x - same as "%m/%d/%y"
  127.     %X - same as "%H:%M:%S"
  128.     %y - year using two digits with leading 0s
  129.     %Y - year using four digits with leading 0s
  130. @ENDNODE
  131. ###########################################################################
  132. @NODE TOOLTYPES
  133.                                  TOOLTYPES
  134.  @{fg highlight}DONOTWAIT=YES@{fg text}
  135.     You  should  set this always to YES to keep sure that the Workbench
  136.     task does not wait for termination of the program while booting up.
  137.  @{fg highlight}TOOLPRI=<number>@{fg text}
  138.     Sets  task priority to <number> (default 0). Suggested value is 15,
  139.     which  will enable ProxWatch to update the watch string immediately
  140.     in most cases.
  141.  @{fg highlight}STARTPRI=<number>@{fg text}
  142.     Sets WBStartup priority to <number> (default 0).
  143.  @{fg highlight}PUBSCREEN=<name>@{fg text}
  144.     Uses  the  public  screen  <name>  for the ProxWatch window. If the
  145.     screen  does  not  exist the default public screen is used. You may
  146.     use  the  string  'Workbench'  to  open the window on the Workbench
  147.     screen.
  148.  @{fg highlight}WATCHSTRING=<template>@{fg text}
  149.     The  template  describing  the  desired @{"format" LINK DATEFORMAT} of the date and time
  150.     string.
  151.  @{fg highlight}HELPTEXT=<name>@{fg text}
  152.     The complete path to this ProxWatch Amigaguide document. Default is
  153.     'HELP:english/ProxWatch.guide'.
  154.  @{fg highlight}CLOSEGADGET=YES@{fg text}
  155.     Specify YES if you want a close gadget. Defaults to NO.
  156.  @{fg highlight}DEPTHGADGET=YES@{fg text}
  157.     Specify YES if you want a depth gadget. Defaults to NO.
  158.  @{fg highlight}BACKDROP=YES@{fg text}
  159.     If  BACKDROP  is  set  to  YES  the ProxWatch window will open as a
  160.     borderless  not  dragable backdrop window. The text is in this case
  161.     printed  in  the  colours  of  the underlying screen bar, therefore
  162.     giving  the  impression  that the watch text is added to the screen
  163.     title.  CLOSEGADGET  and DEPTHGADGET will be forced to NO.
  164. @ENDNODE
  165. ###########################################################################
  166. @NODE MENUS
  167.                                    MENUS
  168.  @{fg highlight}ABOUT@{fg text}
  169.     Displays version and copyright information.
  170.  @{fg highlight}HELP@{fg text}
  171.     Brings up the documentation pointed to by tooltype @{"HELPTEXT" LINK TOOLTYPES}.
  172.     Help is also available by pressing the Help key.
  173.  @{fg highlight}QUIT@{fg text}
  174.     Exits the program. Same as clicking on the @{"CLOSEGADGET" LINK TOOLTYPES} or pressing
  175.     Esc.
  176. @ENDNODE
  177. ###########################################################################
  178. @NODE HISTORY
  179.                                   HISTORY
  180. 1.1 (18.8.94) Release
  181. First public release.
  182. 1.2 (4.9.94) Release
  183. BUG: Fixed window width calculation reported by Alain Chofardet.
  184. NEW: @{"Backdrop=Yes" LINK TOOLTYPES} tooltype enables a borderless window with the same colours
  185.      as the screen bar.
  186. @ENDNODE
  187.